Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Type
Documentation
Description
MetricPgVecOperatorMap
,PostgresIndex
,PostgresIndexRecord
,FunctionSchema
, andParameter
.max_retries
forOpenAIEncoder
andAzureOpenAIEncoder
.Route Layer
,route_filter
parameter, and synchronization strategies, providing detailed usage examples and explanations.Changes walkthrough 📝
61 files
semantic_router.encoders.AutoEncoder.rst
Fix encoding issue in AutoEncoder documentation
docs/source/_autosummary/semantic_router.encoders.AutoEncoder.rst
semantic_router.encoders.base.BaseEncoder.rst
Fix encoding issue in BaseEncoder documentation
docs/source/_autosummary/semantic_router.encoders.base.BaseEncoder.rst
semantic_router.encoders.bedrock.BedrockEncoder.rst
Fix encoding issue in BedrockEncoder documentation
docs/source/_autosummary/semantic_router.encoders.bedrock.BedrockEncoder.rst
semantic_router.encoders.bm25.BM25Encoder.rst
Fix encoding issue in BM25Encoder documentation
docs/source/_autosummary/semantic_router.encoders.bm25.BM25Encoder.rst
semantic_router.encoders.clip.CLIPEncoder.rst
Fix encoding issue in CLIPEncoder documentation
docs/source/_autosummary/semantic_router.encoders.clip.CLIPEncoder.rst
semantic_router.encoders.cohere.CohereEncoder.rst
Fix encoding issue in CohereEncoder documentation
docs/source/_autosummary/semantic_router.encoders.cohere.CohereEncoder.rst
semantic_router.encoders.fastembed.FastEmbedEncoder.rst
Fix encoding issue in FastEmbedEncoder documentation
docs/source/_autosummary/semantic_router.encoders.fastembed.FastEmbedEncoder.rst
semantic_router.encoders.google.GoogleEncoder.rst
Fix encoding issue in GoogleEncoder documentation
docs/source/_autosummary/semantic_router.encoders.google.GoogleEncoder.rst
semantic_router.encoders.huggingface.HFEndpointEncoder.rst
Fix encoding issue in HFEndpointEncoder documentation
docs/source/_autosummary/semantic_router.encoders.huggingface.HFEndpointEncoder.rst
semantic_router.encoders.huggingface.HuggingFaceEncoder.rst
Fix encoding issue in HuggingFaceEncoder documentation
docs/source/_autosummary/semantic_router.encoders.huggingface.HuggingFaceEncoder.rst
semantic_router.encoders.mistral.MistralEncoder.rst
Fix encoding issue in MistralEncoder documentation
docs/source/_autosummary/semantic_router.encoders.mistral.MistralEncoder.rst
semantic_router.encoders.openai.OpenAIEncoder.rst
Fix encoding issue and add max_retries to OpenAIEncoder
docs/source/_autosummary/semantic_router.encoders.openai.OpenAIEncoder.rst
max_retries
attribute to OpenAIEncoder.semantic_router.encoders.tfidf.TfidfEncoder.rst
Fix encoding issue in TfidfEncoder documentation
docs/source/_autosummary/semantic_router.encoders.tfidf.TfidfEncoder.rst
semantic_router.encoders.vit.VitEncoder.rst
Fix encoding issue in VitEncoder documentation
docs/source/_autosummary/semantic_router.encoders.vit.VitEncoder.rst
semantic_router.encoders.zure.AzureOpenAIEncoder.rst
Fix encoding issue and add max_retries to AzureOpenAIEncoder
docs/source/_autosummary/semantic_router.encoders.zure.AzureOpenAIEncoder.rst
max_retries
attribute to AzureOpenAIEncoder.semantic_router.hybrid_layer.HybridRouteLayer.rst
Fix encoding issue in HybridRouteLayer documentation
docs/source/_autosummary/semantic_router.hybrid_layer.HybridRouteLayer.rst
semantic_router.index.base.BaseIndex.rst
Fix encoding issue and add methods to BaseIndex
docs/source/_autosummary/semantic_router.index.base.BaseIndex.rst
aget_routes
andget_routes
methods to BaseIndex.semantic_router.index.local.LocalIndex.rst
Fix encoding issue and add method to LocalIndex
docs/source/_autosummary/semantic_router.index.local.LocalIndex.rst
aget_routes
method to LocalIndex.semantic_router.index.pinecone.PineconeIndex.rst
Fix encoding issue and add method to PineconeIndex
docs/source/_autosummary/semantic_router.index.pinecone.PineconeIndex.rst
aget_routes
method to PineconeIndex.semantic_router.index.pinecone.PineconeRecord.rst
Fix encoding issue in PineconeRecord documentation
docs/source/_autosummary/semantic_router.index.pinecone.PineconeRecord.rst
semantic_router.index.postgres.MetricPgVecOperatorMap.rst
Add documentation for MetricPgVecOperatorMap
docs/source/_autosummary/semantic_router.index.postgres.MetricPgVecOperatorMap.rst
semantic_router.index.postgres.PostgresIndex.rst
Add documentation for PostgresIndex
docs/source/_autosummary/semantic_router.index.postgres.PostgresIndex.rst
semantic_router.index.postgres.PostgresIndexRecord.rst
Add documentation for PostgresIndexRecord
docs/source/_autosummary/semantic_router.index.postgres.PostgresIndexRecord.rst
semantic_router.index.postgres.clean_route_name.rst
Add documentation for clean_route_name function
docs/source/_autosummary/semantic_router.index.postgres.clean_route_name.rst
semantic_router.index.postgres.parse_vector.rst
Add documentation for parse_vector function
docs/source/_autosummary/semantic_router.index.postgres.parse_vector.rst
semantic_router.index.postgres.rst
Add documentation for semantic_router.index.postgres module
docs/source/_autosummary/semantic_router.index.postgres.rst
semantic_router.index.qdrant.QdrantIndex.rst
Fix encoding issue and add method to QdrantIndex
docs/source/_autosummary/semantic_router.index.qdrant.QdrantIndex.rst
aget_routes
method to QdrantIndex.semantic_router.index.rst
Fix encoding issue and add postgres reference
docs/source/_autosummary/semantic_router.index.rst
semantic_router.layer.LayerConfig.rst
Fix encoding issue in LayerConfig documentation
docs/source/_autosummary/semantic_router.layer.LayerConfig.rst
semantic_router.layer.RouteLayer.rst
Fix encoding issue in RouteLayer documentation
docs/source/_autosummary/semantic_router.layer.RouteLayer.rst
semantic_router.llms.base.BaseLLM.rst
Fix encoding issue in BaseLLM documentation
docs/source/_autosummary/semantic_router.llms.base.BaseLLM.rst
semantic_router.llms.cohere.CohereLLM.rst
Fix encoding issue in CohereLLM documentation
docs/source/_autosummary/semantic_router.llms.cohere.CohereLLM.rst
semantic_router.llms.llamacpp.LlamaCppLLM.rst
Fix encoding issue in LlamaCppLLM documentation
docs/source/_autosummary/semantic_router.llms.llamacpp.LlamaCppLLM.rst
semantic_router.llms.mistral.MistralAILLM.rst
Fix encoding issue in MistralAILLM documentation
docs/source/_autosummary/semantic_router.llms.mistral.MistralAILLM.rst
semantic_router.llms.ollama.OllamaLLM.rst
Fix encoding issue in OllamaLLM documentation
docs/source/_autosummary/semantic_router.llms.ollama.OllamaLLM.rst
semantic_router.llms.openai.OpenAILLM.rst
Fix encoding issue in OpenAILLM documentation
docs/source/_autosummary/semantic_router.llms.openai.OpenAILLM.rst
semantic_router.llms.openrouter.OpenRouterLLM.rst
Fix encoding issue in OpenRouterLLM documentation
docs/source/_autosummary/semantic_router.llms.openrouter.OpenRouterLLM.rst
semantic_router.llms.zure.AzureOpenAILLM.rst
Fix encoding issue in AzureOpenAILLM documentation
docs/source/_autosummary/semantic_router.llms.zure.AzureOpenAILLM.rst
semantic_router.route.Route.rst
Fix encoding issue in Route documentation
docs/source/_autosummary/semantic_router.route.Route.rst
semantic_router.schema.DocumentSplit.rst
Fix encoding issue in DocumentSplit documentation
docs/source/_autosummary/semantic_router.schema.DocumentSplit.rst
semantic_router.schema.EncoderInfo.rst
Fix encoding issue in EncoderInfo documentation
docs/source/_autosummary/semantic_router.schema.EncoderInfo.rst
semantic_router.schema.EncoderType.rst
Fix encoding issue in EncoderType documentation
docs/source/_autosummary/semantic_router.schema.EncoderType.rst
semantic_router.schema.Message.rst
Fix encoding issue in Message documentation
docs/source/_autosummary/semantic_router.schema.Message.rst
semantic_router.schema.Metric.rst
Fix encoding issue in Metric documentation
docs/source/_autosummary/semantic_router.schema.Metric.rst
semantic_router.schema.RouteChoice.rst
Fix encoding issue in RouteChoice documentation
docs/source/_autosummary/semantic_router.schema.RouteChoice.rst
semantic_router.splitters.base.BaseSplitter.rst
Fix encoding issue in BaseSplitter documentation
docs/source/_autosummary/semantic_router.splitters.base.BaseSplitter.rst
semantic_router.splitters.consecutive_sim.ConsecutiveSimSplitter.rst
Fix encoding issue in ConsecutiveSimSplitter documentation
docs/source/_autosummary/semantic_router.splitters.consecutive_sim.ConsecutiveSimSplitter.rst
semantic_router.splitters.cumulative_sim.CumulativeSimSplitter.rst
Fix encoding issue in CumulativeSimSplitter documentation
docs/source/_autosummary/semantic_router.splitters.cumulative_sim.CumulativeSimSplitter.rst
semantic_router.splitters.rolling_window.RollingWindowSplitter.rst
Fix encoding issue in RollingWindowSplitter documentation
docs/source/_autosummary/semantic_router.splitters.rolling_window.RollingWindowSplitter.rst
semantic_router.splitters.rolling_window.SplitStatistics.rst
Fix encoding issue in SplitStatistics documentation
docs/source/_autosummary/semantic_router.splitters.rolling_window.SplitStatistics.rst
semantic_router.text.Conversation.rst
Fix encoding issue in Conversation documentation
docs/source/_autosummary/semantic_router.text.Conversation.rst
semantic_router.utils.defaults.EncoderDefault.rst
Fix encoding issue in EncoderDefault documentation
docs/source/_autosummary/semantic_router.utils.defaults.EncoderDefault.rst
semantic_router.utils.function_call.FunctionSchema.rst
Add documentation for FunctionSchema
docs/source/_autosummary/semantic_router.utils.function_call.FunctionSchema.rst
semantic_router.utils.function_call.Parameter.rst
Add documentation for Parameter
docs/source/_autosummary/semantic_router.utils.function_call.Parameter.rst
semantic_router.utils.function_call.rst
Fix encoding issue and add class references
docs/source/_autosummary/semantic_router.utils.function_call.rst
semantic_router.utils.logger.CustomFormatter.rst
Fix encoding issue in CustomFormatter documentation
docs/source/_autosummary/semantic_router.utils.logger.CustomFormatter.rst
api.rst
Remove API reference documentation
docs/source/api.rst
index.rst
Update index with new documentation structure
docs/source/index.rst
route_layer.rst
Add documentation for Route Layer
docs/source/route_layer.rst
route_filter.rst
Add documentation for route_filter parameter
docs/source/route_layer/route_filter.rst
sync.rst
Add documentation for synchronization strategies
docs/source/route_layer/sync.rst